MacFormat 1995 June/MacFormat 25.iso/Shareware City/Developers/fantasm 2.1 unreg/EditII/Edit II Doc

Text File | 1992-03-12 | 15.8 KB | 496 lines | [TEXT/MACA]

Edit II Version 2.0.1
© 1990-92 Kenneth Seah
Portions © by Symantec

An enhanced text editor for the Macintosh

0.    Prologue

This application is copyrighted by Kenneth Seah and is distributed as
shareware. You are welcome to try out Edit II for a week or two and if you
decide that it's something you want to use, send a check drawn on a US Bank
or a draft for US$15 made out to me at the address below, enclosing the
little questionaire.  I'll answer your problems and consider bug fixes via
electronic mail (Internet, America OnLine or GEnie) if you are registered.

Otherwise, give a copy of it to a friend, enclosing this file too and trash
your copy (since it takes up valuable space on your disk).

I'll consider that you have been registered once you have sent in your
shareware fee.  Upgrades will be posted to America OnLine, GEnie and
Internet.  I can work out a 'site licence' fee if you need several copies
installed at your place.

For commercial distribution and correspondence, please contact:

Kenneth Seah
P O Box 8565
Austin, TX 78713-8565

GEnie: K.SEAH
America OnLine: KSeah
Internet: [e-mail]

1.    Introduction

Edit II is intended as a replacement for the Consulair Edit text editor but
which alllows the use of the cursor keys on the Mac keyboard for
navigation. Additionally, the num lock LED on the extended keyboard is used
to indicate whether the cursor pad or the numeric pad mode is on.  The
home, end, page up, page down keys will also work, as will the delete right
(del) key.  One level of undo is supported.  You can launch Edit II by
double clicking old Edit files (since Edit II uses the same creator
signature as Edit, that is, EDIT). This means that you might want to
rebuild the desktop after installing Edit II.

Edit II requires System Software 4.1 or later and above and is
Multifinder-friendly.  It is also 32-bit clean and runs fine under System
7.

This program is compiled using Think C 5.0.2 and uses the Capps’ Editor
Toolkit.

2.    Menus

Edit II works just like Consulair's Edit.  Each of the menus and their
respective commands are described in the subsequent paragraphs.

File menu

New
    Creates a new window named 'Untitled-N' for editing.

Open...
    Displays the standard file open dialog box to allow the selection of a
file to edit.  The dialog box will display all files of type 'TEXT', 'RRRS'
(Red Ryder script files) and 'ttro' (TeachText read-only text files).

Close
    Closes the frontmost editing window.  If the file has been changed in any
way, the standard file save dialog box will be displayed.

Save
    Saves the frontmost window to its file on disk.  If the file has not been
previously saved, perform a 'Save As...' operation.

Save As...
    Saves the frontmost window to a differently named file by presenting the
standard file save dialog box.

Revert
    Reverts the frontmost window to the most recently saved version of the
file.  A prompt message is displayed to confirm the action.

Page Setup...
    Displays the standard printer Page Setup dialog box.

Print
    Displays the standard printer Print dialog box to initiate printing of the
frontmost window.

Transfer
    Displays the standard file selection dialog box to choose an application
program to run.

Quit
    Quits Edit II after prompting for saving of any changed windows.

Edit menu

Undo
    Reverts from the previous editing operation.

Cut
    Removes the currently selected text and copies it into the clipboard.

Copy
    Copies the currently selected text into the clipboard without deleting it.

Paste
    Pastes the clipboard text at the insertion point.  If a range has been
selected, then the pasted text will replace the selection.

Clear
    Deletes the currently selected text without copying it to the clipboard.

Select All
    Selects all the text in the frontmost window.

Search menu

Find...
    Displays the 'find and replace' dialog box for entry of search (Find) and
replacement (Replace with) strings.  GREP-style searching is available (see
later on how to define GREP search and replacement strings).  The 'find and
replace' dialog box has several options:

    'Match Words' will only flag a match if there is an exact word for word
match with the search string.

    'Wrap Around' will flag matches even when the words wrap over at the end
of a line.

    'Ignore Case' will flag matches even when the cases (capitals and small
letters) do not match but the letters do.

    There is an option to do multi-file searches of all TEXT-type files inside
a folder.  The multi-file search is activated by clicking on the Multi-File
Search checkbox which brings up the standard file selection dialog box.
Selecting a TEXT-type file will initiate multi-file searches of the search
string for all TEXT-type files within the folder.  Note that multi-file
searching does not descend into subfolders (i.e. one folder level only).

    Cutting and pasting of text selections is allowed into the search and
replacement strings in the 'find and replace' dialog box.  This is achieved
by using the command-C and command-V combinations.  If you want to enter
the tab or return characters in the Find dialog box, key in command-tab and
command-return respectively.

    Search and replacement strings are retained between searches.  The 'Don't
Find' button will retain the search and replacement string entries but will
not initiate any searches.  The 'Cancel' button on the other hand, will
ignore any entries made for these strings.

Enter Selection
    Puts the currently selected text into the search string.

Replace
    Replaces the currently selected text with the replacement string.

Replace and Find Again
    Replaces the currently selected text with the replacement string and
searches for the next occurrence of the search string.

Replace All...
    Replaces all occurences of the search string with the replacement string.
Prompts for confirmed replacement if required.

Find in Next File
    Only operable under multi-file searches – will look for occurence of the
search string in the next file in the specified folder.

Go to Top
Go to Bottom
    Move the insertion point to the beginning or end of the file,
respectively.

Go to Line#...
    Displays a dialog and moves to the specified line.

Goodies menu

Shift Left
Shift Right
    Moves the selected text one space to the left or right.

Balance
    Extends current selection to encompass the next level of enclosing braces
{}, brackets [] or parentheses ().  A beep means that the text could not be
balanced. [Great for C and Lisp people!]

Add LFs
    Adds linefeed characters to the end of every line.

Strip LFs
    Removes linefeed characters from the text.

Wrap to Column...
    Wraps the text to a user-specified column.

Wrap to Window
    Wraps the text to the window width.

Unwrap
    Almost the reverse of the above wraps.  What Unwrap does is to replace all
single occurences of the 'return' character by a space and leave multiple
runs of returns untouched.  Thus a 'paragraph' is recognized as ending in
two or more returns.
Remove Invisibles
    Removes all the invisible (non-printing) characters with the exceptions of
tab, return and linefeed.


Options menu

Font
Size
Creator
    Select the font, size and  creator for the file being edited.  The size
submenu has 'Larger', 'Smaller' and 'Other...' commands to allow for
selection of non-standard sizes.  The creators supported by Edit II are:

EDIT    Consulair Edit (and Edit II)
MPS    Apple MPW
KAHL    Think C
PJMM    Think Pascal
ALFA    Alpha
MACA    MacWrite
MSWD    Microsoft Word
nX^n    WriteNow
ttxt    TeachText
PEDT    DA Edit or PEdit
WNGZ    WingZ

    Default font is Monaco, default size is 9 and default creator is EDIT.

Set Tabs...
    Sets the number of spaces to one tab stop (default is 4 spaces to one
tab).

AutoIndent
    Toggles automatic indentation of text (useful for programmers).  Default
is autoindent on.

Strip LF
SmartStrip
    If these two options are not selected, then linefeeds in text files are
not filtered but passed as is.  Selecting the Strip LF option removes the
linefeeds when the files are read in.  SmartStrip is an intelligent
linefeed remover in which linefeeds are removed when the file is read and
replaced (after each CR or replacing each CR - depending on the input
format) when the file is written back.  The default option is SmartStrip.

New Untitled
    If selected, displays an Untitled window when starting Edit II (next time
of course).  Default is on.

Print Headers
    If selected will print informative header information at the top of every
page.  Default is to print these headers.

Save Preferences
    Saves the option settings (all the items in the option menu) into the
EditPrefs file which is stored in the Preferences folder of the System
Folder.

Windows menu

Layer
    Layers all the windows neatly on the screen.  The previous frontmost
window is brought to the front.

Tile
    Tiles all the windows neatly on the screen.  The previous frontmost window
is selected.  This option is active for 9 or less windows.

Close All
Save All
    Closes (or saves) all the displayed windows.  Saving does not close any
windows.  Any untitled windows will be 'saved as'.

<window name list>
    Each of the window names appears here for rapid selection.  The first 9
windows have command key equivalents 'command-1' through 'command-9'.  Edit
II can now handle unlimited windows (subject to available system memory set
aside for it of course).

3.    Keyboard Frolics

Cursor keys on the Macintosh Plus and above now work.  In addition, if you
have an extended keyboard, then the extra keys between the main keys and
keypad also work as follows:

page up
    Moves to the previous screenful of text without changing the insertion
point.

page down
    Moves to the next screenful of text without changing the insertion point.

home
    Moves the insertion point to the beginning of the file.

end
    Moves the insertion point to the end of the file.

del (delete to right)
    Deletes the character to the right of the insertion point.

enter (on keypad)
    Scrolls to the insertion point.

- (on keypad)
    Jumps around the five insertion points last clicked at.  Note that
double-clicking to select a word counts as two insertion points (a quirk of
Capps’) and that Edit II will cycle through all five points, even though
they are the same (like at the beginning).  So if the insertion point seems
stuck, keep on pressing '-'!

F1–F4
    Undo, Cut, Copy and Paste.

option-return
    If autoindent mode is on, then hitting option-return will move the
insertion point to the start of the next line and not to do any
autoindenting for that line.

You can also toggle the special cursor pad mode by hitting the num lock key
on the numeric keypad.  The num lock light on the keyboard will go off
(indicating that the numeric keypad is now in cursor mode).  This displays
an additional (disabled) menu called CursorPad.  The keys on the numeric
keypad now take on special functionality as given below (like the I*M
keypad):


4.    GREP searching and replacement

GREP searching can be now done using regular expressions like the Unix GREP
tool. Pattern matching of regular expressions is carried out as follows:

Patterns (regular expressions)

1.    Any non-special character is a regular expression which matches itself.
Characters [ ] \ and . are special characters and should be preceded by \
(see rule 4).

2.    A regular expression can be concatenated with another regular
expression.

3.    The . (period) is a special character which matches any one character.

4.    The \ followed by any character except ( ) < > or one of the digits 1-9
is a regular expression which matches that character.

5.    A string of characters s surrounded by brackets [ ] forms a regular
expression that exactly matches any one of the characters in s.  The
regular expression [^ß] matches any character not in the string ß.  If a
sequence of 3 characters a-b occurs in the string, then this represents all
the characters from a to b inclusive.

6.    A regular expression R followed by * forms a regular expression which
matches zero or more occurences of R.

7.    A regular expression surrounded by \( and \) matches whatever the
regular  expression matches.

8.    A \ followed by a digit n 1 to 9 is a regular expression which matches
whatever the nth subexpression surrounded by \( \) matches.

9.    A regular expression surrounded by \< and \> constrains the match to
occur when the regular expression is immediately preceded and followed by
characters which do not match [A-Za-z0-9_] and the first and last
characters match [A-Za-z0-9_].  This allows us to look for "words".

10.    A regular expression which starts with ^ anchors the search pattern to
the start of a line.  The ^ appearing anywhere else in the regular
expression will match the character ^.

11.    A regular expression ending in $ will anchor the search pattern to the
end of a line.  The $ appearing anywhere else in the regular expression
will match the $.

Replacements

1.    Each occurence of & in the replacement string will be substituted with
whatever was last matched by the regular expression.

2.    Each occurence of the form \n where n is a digit 1 to 9 will substitute
whatever was matched by the nth subexpression enclosed in \( and \).

3.    Each occurence of the form \p where p is not a digit 1 to 9 will
substitute that character p.

5.    Workarounds and other hints

Edit II can only search for a pattern in a forward direction.  If you want
to search backwards, the best workaround is to go back to the start of the
file (home) and then search.

All files are edited in memory.  So if you have a large file, reset the
size of the application using Get Info on the Edit II application icon and
change the size of the application memory. Or better still - run under the
Finder (and not MultiFinder).  Naturally you shouldn't edit a 2MB file on a
1MB Mac using Edit II!  Try as far as possible to have approximately twice
the memory assigned to Edit II than the total size of all the files you're
editing.

Holding the option key when Edit II is starting up will bring up the
standard file open dialog box for you to select the name of a file to edit.

Users of PwrSwitcher should hit option-num lock to turn on cursor pad mode
without causing a switch to the next application.

Edit II will try to save files when memory runs too low but there is no
guarantee that it won't crash while doing this.  The advice is to
frequently check the available space (see the About Edit II... box to show
the current amount of free memory).

Additional creator names can be inserted into the Creator menu by using
ResEdit (use at your own risk!!).  Note that exactly FOUR letters must be
keyed in for each creator name.

Holding the control key when quitting from Edit II will forcibly turn off
the num lock LED (just in case you ever need it!).

6.    Bug Reports

If you find any bugs with this program, please write to me at the above
address. You can also send electronic mail to me on GEnie as K.SEAH, on
America OnLine as KSeah or via Internet as [e-mail].

7.    Warranty

Kenneth Seah hereby disclaims all warranties relating to this software,
whether express or implied, including without limitation any implied
warranties of merchantability or fitness for a particular purpose.  Kenneth
Seah will not be liable for any special, incidental, consequential,
indirect or similar damages due to loss of data or any other reason, even
if Kenneth Seah or an agent of his has been advised of the possibility of
such damages.  In no event shall Kenneth Seah's liability for any damages
ever exceed the price paid for the license to use software, regardless of
the form of the claim.  The person using the software bears all risk as to
the quality and performance of the software.

8.    Questionaire

Copy, print this and fill in the blanks!

REGISTERING FOR: Edit II Version 2.0.1 March 12, 1992

NAME:





ADDRESS:





CITY:


STATE:


ZIP:

ELECTRONIC MAIL ADDRESSES (GEnie, InterNet, Compu$erve, AppleLink, America
OnLine): [For updates and bug reports]




Macintosh you have:




Current version of your System Software:





Comments about Edit II (add more space if desired!):







>>> Don't forget the US$15 shareware fee <<<